/**
 * This file Copyright (c) 2010-2012 Magnolia International
 * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
 *
 *
 * This file is dual-licensed under both the Magnolia
 * Network Agreement and the GNU General Public License.
 * You may elect to use one or the other of these licenses.
 *
 * This file is distributed in the hope that it will be
 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
 * Redistribution, except as permitted by whichever of the GPL
 * or MNA you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or
 * modify this file under the terms of the GNU General
 * Public License, Version 3, as published by the Free Software
 * Foundation.  You should have received a copy of the GNU
 * General Public License, Version 3 along with this program;
 * if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * 2. For the Magnolia Network Agreement (MNA), this file
 * and the accompanying materials are made available under the
 * terms of the MNA which accompanies this distribution, and
 * is available at http://www.magnolia-cms.com/mna.html
 *
 * Any modifications to this file must keep this entire header
 * intact.
 *
 */
package com.aplana.ccsd;

import info.magnolia.module.DefaultModuleVersionHandler;
import info.magnolia.module.InstallContext;
import info.magnolia.module.delta.DeltaBuilder;
import info.magnolia.module.delta.ModuleBootstrapTask;
import info.magnolia.module.delta.ModuleFilesExtraction;
import info.magnolia.module.delta.Task;

import java.util.ArrayList;
import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * VersionHandler for the module.
 */
public class BlossomSampleVersionHandler extends DefaultModuleVersionHandler {

	@SuppressWarnings("unused")
	private static final Logger LOGGER = LoggerFactory
			.getLogger(BlossomSampleVersionHandler.class);

	/**
	 * ModuleVersionHandler Constructor.
	 * 
	 * Register any tasks in here that need to happen as part of an update. All
	 * though the constructor here will always be invoked, it will only ever
	 * have an effect for updates (not new installs) because the DeltaBuilder is
	 * adding "update" tasks. By default new installs are setup correctly
	 * through inherited behaviour. However, if you need to perform additional
	 * non default tasks as part of a new install the way this needs to be done
	 * is by overriding the getExtraInstallTasks() method and adding additional
	 * non-default tasks in here.
	 * 
	 * @see <a
	 *      href="http://wiki.magnolia-cms.com/display/WIKI/Handling+module+versions">
	 *      http://wiki.magnolia-cms.com/display/WIKI/Handling+module+versions

	 *      </a> for more info on module versioning
	 * 
	 */
	public BlossomSampleVersionHandler() {
		// Register the module using version specified in the properties.
		register(DeltaBuilder.update("1.0.0-SNAPSHOT", "")
				.addTasks(getCommonTasks()));
	}

	/**
	 * Overwrites the list of tasks to perform during module installation.
	 */
	@Override
	protected List<Task> getExtraInstallTasks(InstallContext installContext) {
		return this.getCommonTasks();
	}

	/**
	 * Return the common task for every module update.
	 * 
	 * @return
	 */
	private List<Task> getCommonTasks() {
		
		final List<Task> commonTasks = new ArrayList<Task>();

		// Installs all files from
		// /src/main/resources/mgnl-bootstrap
		commonTasks.add(new ModuleBootstrapTask());

		// Extracts all files from
		// /src/main/resources/mgnl-files
		commonTasks.add(new ModuleFilesExtraction());

		return commonTasks;
	}
}
